Oxygen Multimedia Graphics 22/Oxygen Multimedia Graphics 22.iso/pc/System/OX22/Internal_29_Cycle Graphics.ls

Text File | 2008-03-12 | 11.0 KB | 277 lines

property spriteNum, mySprite, myFirstMember, myLastMember, myFrameTime, myTimeUnit, myPlayBackwards, myMembersList, myMemberCount, myCurrentMember, myListPosition, myLoopFlag, myMilliseconds

on getBehaviorDescription me
  return "CYCLE GRAPHICS" & RETURN & RETURN & "This behavior cycles through a series of consecutive cast members." & RETURN & RETURN & "It gives you all the features of a single member filmloop, plus the possibility of precise control via Lingo. " & "These possibilities include speed control, starting and stopping at an arbitrary image, modifying the list of images to cycle through and more. " & "(See Public Methods below.)" & RETURN & RETURN & "You simply arrange your castmembers in the order they should appear in the cycle, then use the Parameters dialog to indicate the first and last images. " & "You can use any type of graphic member. " & "Spaces between cast members will be ignored." & RETURN & RETURN & "The registration point of each member will appear at the location of the current sprite. " & "If necessary, modify the registration point of each member individually so that it appears in the correct position relative to the other members of the cycle." & RETURN & RETURN & "If you shift the members to different cast slots, you will need to alter the settings in the Parameters dialog: a film loop can keep track of where you drag its members to, but this behavior cannot do that." & RETURN & RETURN & "The images cannot cycle faster than the current frame tempo. " & "If you need to cycle faster, either increase the tempo or reduce the number of images in the list. " & "At speeds of more than 60 images per second, the human eye is incapable of distinguishing individual images, so higher speeds are unnecessary." & RETURN & RETURN & "PERMITTED MEMBER TYPES:" & RETURN & "bitmap, button, field, filmloop, Flash, Director movie," & RETURN & "QuickTime, shape, text, vector shape" & RETURN & RETURN & "PARAMETERS:" & RETURN & "* First member of series" & RETURN & "* Last member of series" & RETURN & "* Maximum speed" & RETURN & "* Cycle direction (forwards or backwards)" & RETURN & "* Start cycling on beginsprite" & RETURN & RETURN & "If you choose not to start cycling images on beginsprite, then you need to send a CycleGraphics_ToggleLoop message to the sprite or the behavior to make the cycle start." & RETURN & RETURN & "PUBLIC METHODS:" & RETURN & "* Determine which image is currently showing" & RETURN & "* Cycle images at the frameTempo or slower" & RETURN & "* Play the images forwards or backwards" & RETURN & "* Start and stop at an arbitrary image" & RETURN & "* Jump to a given image" & RETURN & "* Determine or modify the list of images to cycle through" & RETURN & "* Obtain the behavior reference"
end

on getBehaviorTooltip me
  return "Use with any graphic member." & RETURN & RETURN & "Cycles a sprite through a series of images at a rate independent of the frame tempo." & RETURN & RETURN & "This behavior gives you all the features of a single member filmloop, plus precise control via Lingo. " & "You can stop/start the cycle, alter the speed, jump to an arbitrary member, reverse the direction of the cycle, get and set the list of members to cycle through, and determine which image is currently showing." & RETURN & RETURN & "See the Notes for Developers in the script for more details."
end

on beginSprite me
  myTimeUnit = resolve(myTimeUnit)
  myPlayBackwards = resolve(myPlayBackwards)
  Initialize(me)
end

on resolve prop
  case prop of
    myTimeUnit:
      choiceslist = ["Images Per Second", "Ticks Per Image", "Seconds Per Image", "Minutes Per Image"]
      lookup = ["images per second", "ticks per image", "seconds per image", "minutes per image"]
    myPlayBackwards:
      choiceslist = ["Forwards", "Backwards"]
      lookup = [#forwards, #backwards]
  end case
  return lookup[findPos(choiceslist, prop)]
end

on prepareFrame me
  update(me)
end

on Initialize me
  mySprite = sprite(me.spriteNum)
  case myTimeUnit of
    "images per second":
      myFrameTime = 1000 / myFrameTime
    "ticks per image":
      myFrameTime = myFrameTime * 1000 / 60
    "seconds per image":
      myFrameTime = myFrameTime * 1000
    "minutes per image":
      myFrameTime = myFrameTime * 1000 * 60
  end case
  case myPlayBackwards of
    #forwards:
      myPlayBackwards = 0
    #backwards:
      myPlayBackwards = 1
    otherwise:
      return #invalidSymbolError
  end case
  myFirstMember = member(myFirstMember)
  myLastMember = member(myLastMember)
  minMember = min(myFirstMember.number, myLastMember.number)
  maxMember = max(myFirstMember.number, myLastMember.number)
  myMembersList = []
  repeat with memberNumber = minMember to maxMember
    theMember = member(memberNumber)
    myMembersList.append(theMember)
  end repeat
  checkedList = StripNonGraphicMembers(me, duplicate(myMembersList))
  if checkedList <> myMembersList then
    ErrorAlert(me, #invalidMembers)
    myMembersList = checkedList
  end if
  myMemberCount = myMembersList.count()
  myListPosition = 1
  myMilliseconds = the milliSeconds
end

on update me
  if not myLoopFlag then
    exit
  end if
  elapsedTime = the milliSeconds - myMilliseconds
  if abs(elapsedTime < myFrameTime) then
    exit
  else
    if elapsedTime > (myFrameTime * 2) then
      myMilliseconds = the milliSeconds
    end if
  end if
  myMilliseconds = myMilliseconds + myFrameTime
  if myPlayBackwards then
    myListPosition = myListPosition - 2 + myMemberCount
  end if
  myListPosition = (myListPosition mod myMemberCount) + 1
  myCurrentMember = myMembersList[myListPosition]
  mySprite.member = myCurrentMember
end

on CycleGraphics_GetCurrentMember me
  return myCurrentMember
end

on CycleGraphics_GetMembersList me
  return myMembersList
end

on CycleGraphics_ToggleLoop me, trueOrFalse
  if voidp(trueOrFalse) then
    myLoopFlag = not myLoopFlag
  else
    if ilk(trueOrFalse) <> #integer then
      return #invalidTypeError
    else
      myLoopFlag = trueOrFalse
    end if
  end if
  if myLoopFlag then
    myMilliseconds = the milliSeconds
  end if
end

on CycleGraphics_ToggleDirection me, playBackwards
  if voidp(playBackwards) then
    myPlayBackwards = not myPlayBackwards
  else
    case playBackwards of
      #forward, #forwards, 0:
        myPlayBackwards = 0
      #back, #backward, #backwards, #reverse, 1:
        myPlayBackwards = 1
      otherwise:
        return #invalidSymbolError
    end case
  end if
  myMilliseconds = the milliSeconds
end

on CycleGraphics_ShowImage me, theImage
  case ilk(theImage) of
    #integer:
      if (theImage < 1) or (theImage > myMemberCount) then
        return #outOfRangeError
      else
        myListPosition = theImage
        myCurrentMember = myMembersList[myListPosition]
      end if
    #member:
      listPosition = myMembersList.getPos(theImage)
      if listPosition then
        myCurrentMember = theImage
        myListPosition = listPosition
      else
        return #notInListError
      end if
    otherwise:
      return #invalidTypeError
  end case
  mySprite.member = myCurrentMember
  myMilliseconds = the milliSeconds
  updateStage()
end

on CycleGraphics_SetFrameTime me, theMilliseconds
  if ilk(theMilliseconds) <> #integer then
    return #invalidTypeError
  else
    if ilk(theMilliseconds) < 0 then
      return #outOfRangeError
    end if
  end if
  myFrameTime = theMilliseconds
end

on CycleGraphics_SetMembersList me, membersList
  if ilk(membersList) <> #list then
    return #invalidTypeError
  end if
  StripNonGraphicMembers(me, membersList)
  if not membersList.count() then
    return #emptyListError
  end if
  myMembersList = membersList
  myMemberCount = myMembersList.count()
  if myPlayBackwards then
    myListPosition = 1
  else
    myListPosition = myMemberCount
  end if
end

on CycleGraphics_GetReference me, theList
  case ilk(theList) of
    #list:
      theList.append(me)
    #propList:
      theList.addProp(me.spriteNum, me)
    otherwise:
      return me
  end case
  return theList
end

on StripNonGraphicMembers me, membersList
  permittedTypes = [#bitmap, #button, #field, #filmLoop, #flash, #movie, #picture, #quickTimeMedia, #shape, #text, #vectorShape]
  i = membersList.count()
  repeat while i
    theMember = membersList[i]
    if ilk(theMember) <> #member then
      membersList.deleteAt(i)
    else
      if not permittedTypes.getPos(theMember.type) then
        membersList.deleteAt(i)
      end if
    end if
    i = i - 1
  end repeat
  return membersList
end

on ErrorAlert me, theError, data
  behaviorName = string(me)
  delete word 1 of behaviorName
  delete char -30001 of behaviorName
  delete char -30001 of behaviorName
  case data.ilk of
    #void:
      data = "<void>"
    #symbol:
      data = "#" & data
  end case
  case theError of
    #invalidMembers:
      if the runMode <> "Author" then
        exit
      end if
      message = substituteStrings(me, "BEHAVIOR ERROR: Frame ^0, Sprite ^1" & RETURN & "Behavior ^2" & RETURN & "Certain members between ^3 and ^4 were not graphical members so they will not be displayed. " & "Check the permitted types list for valid types.", ["^0": the frame, "^1": me.spriteNum, "^2": behaviorName, "^3": myFirstMember, "^4": myLastMember])
      alert(message)
  end case
end

on substituteStrings me, parentString, childStringList
  i = childStringList.count()
  repeat while i
    tempString = EMPTY
    dummyString = childStringList.getPropAt(i)
    replacement = childStringList[i]
    lengthAdjust = dummyString.char.count - 1
    repeat while 1
      position = offset(dummyString, parentString)
      if not position then
        parentString = tempString & parentString
        exit repeat
        next repeat
      end if
      if position <> 1 then
        tempString = tempString & parentString.char[1..position - 1]
      end if
      tempString = tempString & replacement
      delete parentString.char[1..position + lengthAdjust]
    end repeat
    i = i - 1
  end repeat
  return parentString
end

on isOKToAttach me, aSpriteType, aSpriteNum
  case aSpriteType of
    #graphic:
      return getPos([#bitmap, #button, #field, #filmLoop, #flash, #movie, #picture, #quickTimeMedia, #shape, #text, #vectorShape], sprite(aSpriteNum).member.type) <> 0
    #script:
      return 0
  end case
end

on getPropertyDescriptionList
  if not (the currentSpriteNum) then
    exit
  end if
  theMember = sprite(the currentSpriteNum).member
  theMemberNumber = theMember.number
  return [#myFirstMember: [#comment: "First member of series", #format: #graphic, #default: theMember], #myLastMember: [#comment: "Last member of series", #format: #graphic, #default: member(theMemberNumber + 1)], #myFrameTime: [#comment: "Display images at a maximum speed of", #format: #integer, #range: [#min: 1, #max: 120], #default: min(the frameTempo, 120)], #myTimeUnit: [#comment: EMPTY, #format: #string, #range: ["Images Per Second", "Ticks Per Image", "Seconds Per Image", "Minutes Per Image"], #default: "Images Per Second"], #myPlayBackwards: [#comment: "Cycle", #format: #string, #range: ["Forwards", "Backwards"], #default: "Forwards"], #myLoopFlag: [#comment: "Start cycling on beginSprite?", #format: #boolean, #default: 1]]
end